/*
 * Copyright (C) 2010 Fores Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package jp.fores.midori.core.util;

import java.io.IOException;
import java.io.Serializable;
import java.io.UnsupportedEncodingException;

/**
 * Base64関連の処理を行うユーティリティクラス。<br>
 * (このクラスの全てのメソッドはスレッドセーフです。)<br>
 */
public class Base64Util {
	//==========================================================
	//メソッド

	//_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/
	//コンストラクタ

	/**
	 * コンストラクタです。<br>
	 * (クラスメソッドのみのユーティリティークラスなので、privateにしてインスタンスを作成できないようにしています。)<br>
	 */
	private Base64Util() {
		//基底クラスのコンストラクタの呼び出し
		super();
	}


	//_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/
	//クラスメソッド

	/**
	 * バイト配列をBase64形式のバイト配列にエンコーディングします。<br>
	 *
	 * @param byteArray バイト配列
	 * @return BASE64形式のバイト配列
	 */
	public static byte[] encodeBase64ByteArray(byte[] byteArray) {
		//バイト配列をBase64形式の文字列にエンコーディングして、さらにバイト配列に変換して返す
		return byteArrayToBase64String(byteArray).getBytes();
	}

	/**
	 * Base64形式のバイト配列をデコードして、元のバイト配列に戻します。<br>
	 *
	 * @param byteArray Base64形式の元のバイト配列
	 * @return 元のバイト配列
	 */
	public static byte[] decodeBase64ByteArray(byte[] byteArray) {
		try {
			//バイト配列をBase64形式の文字列に変換して、さらにデコードして返す
			//(Base64にはASCII文字しか含まれないので、他の文字エンコーディングよりも処理が若干高速なUS-ASCIIを指定する)
			return base64StringToByteArray(new String(byteArray, "US-ASCII"));
		}
		//サポートされていない文字エンコーディングの場合
		catch (UnsupportedEncodingException e) {
			//「US-ASCII」がサポートされていないことはありえないので、
			//捕捉した例外をErrorでラッピングして投げ直す
			throw new Error("内部エラーが発生しました。", e);
		}
	}

	/**
	 * バイト配列をBase64形式の文字列にエンコーディングします。<br>
	 *
	 * @param byteArray バイト配列
	 * @return BASE64形式の文字列
	 */
	public static String byteArrayToBase64String(byte[] byteArray) {
		//Seasar2のBase64ユーティリティクラスに処理を委譲する
		return Seasar2Base64Util.encode(byteArray);
	}

	/**
	 * Base64形式の文字列をデコードして、元のバイト配列に戻します。<br>
	 *
	 * @param str Base64形式の文字列
	 * @return 元のバイト配列
	 */
	public static byte[] base64StringToByteArray(String str) {
		//Seasar2のBase64ユーティリティクラスに処理を委譲する
		return Seasar2Base64Util.decode(str);
	}

	/**
	 * 文字列をBase64形式にエンコーディングします。<br>
	 *
	 * @param str 文字列
	 * @return Base64形式の文字列
	 */
	public static String encodeBase64String(String str) {
		try {
			//文字列を「UTF-8」でバイト配列に展開して、さらにBase64形式の文字列にエンコーディングして返す
			return byteArrayToBase64String(str.getBytes("UTF-8"));
		}
		//サポートされていない文字エンコーディングの場合
		catch (UnsupportedEncodingException e) {
			//「UTF-8」がサポートされていないことはありえないので、
			//捕捉した例外をErrorでラッピングして投げ直す
			throw new Error("内部エラーが発生しました。", e);
		}
	}

	/**
	 * Base64形式の文字列をデコードして、元の文字列に戻します。<br>
	 *
	 * @param str Base64形式の文字列
	 * @return 元の文字列
	 */
	public static String decodeBase64String(String str) {
		try {
			//Base64形式の文字列をデコードしたバイト配列を、「UTF-8」で再び文字列に組み立て直して返す
			return new String(base64StringToByteArray(str), "UTF-8");
		}
		//サポートされていない文字エンコーディングの場合
		catch (UnsupportedEncodingException e) {
			//「UTF-8」がサポートされていないことはありえないので、
			//捕捉した例外をErrorでラッピングして投げ直す
			throw new Error("内部エラーが発生しました。", e);
		}
	}

	/**
	 * シリアライズ可能なオブジェクトをBase64形式の文字列にエンコーディングします。<br>
	 *
	 * @param obj シリアライズ可能なオブジェクト
	 * @return Base64形式の文字列
	 * @throws IOException 入出力エラーが発生した場合
	 */
	public static String serializableToBase64String(Serializable obj)
			throws IOException {
		//オブジェクトをシリアライズしてバイト配列に変換して、さらにBase64形式の文字列にエンコーディングして返す
		return byteArrayToBase64String(MidoriSerializationUtils.serialize(obj));
	}

	/**
	 * Base64形式の文字列をデコードして、元のシリアライズ可能なオブジェクトに戻します。<br>
	 *
	 * @param str Base64形式の文字列
	 * @return 元のシリアライズ可能なオブジェクト
	 * @throws IOException 入出力エラーが発生した場合
	 * @throws ClassNotFoundException クラスが見つからなかった場合
	 */
	public static Serializable base64StringToSerializable(String str)
			throws IOException, ClassNotFoundException {
		//Base64形式の文字列をデコードして、さらにデシリアライズして元のオブジェクトに戻して返す
		return (Serializable) MidoriSerializationUtils.deserialize(base64StringToByteArray(str));
	}


	//==========================================================
	//内部クラス

	/**
	 * Seasar2のBase64ユーティリティクラス。<br>
	 * (このクラスのためだけに依存するライブラリを増やしたくはないので、内部処理用のクラスとしてあえて内部クラスで実装しています。)<br>
	 */
	private static class Seasar2Base64Util {
		private static final char[] ENCODE_TABLE = {
				'A',
				'B',
				'C',
				'D',
				'E',
				'F',
				'G',
				'H',
				'I',
				'J',
				'K',
				'L',
				'M',
				'N',
				'O',
				'P',
				'Q',
				'R',
				'S',
				'T',
				'U',
				'V',
				'W',
				'X',
				'Y',
				'Z',
				'a',
				'b',
				'c',
				'd',
				'e',
				'f',
				'g',
				'h',
				'i',
				'j',
				'k',
				'l',
				'm',
				'n',
				'o',
				'p',
				'q',
				'r',
				's',
				't',
				'u',
				'v',
				'w',
				'x',
				'y',
				'z',
				'0',
				'1',
				'2',
				'3',
				'4',
				'5',
				'6',
				'7',
				'8',
				'9',
				'+',
				'/' };

		private static final char PAD = '=';

		private static final byte[] DECODE_TABLE = new byte[128];
		static {
			for (int i = 0; i < DECODE_TABLE.length; i++) {
				DECODE_TABLE[i] = Byte.MAX_VALUE;
			}
			for (int i = 0; i < ENCODE_TABLE.length; i++) {
				DECODE_TABLE[ENCODE_TABLE[i]] = (byte) i;
			}
		}

		/**
		 * Base64でエンコードします。
		 *
		 * @param inData
		 * @return エンコードされたデータ
		 */
		public static String encode(final byte[] inData) {
			if (inData == null || inData.length == 0) {
				return "";
			}
			int mod = inData.length % 3;
			int num = inData.length / 3;
			char[] outData = null;
			if (mod != 0) {
				outData = new char[(num + 1) * 4];
			}
			else {
				outData = new char[num * 4];
			}
			for (int i = 0; i < num; i++) {
				encode(inData, i * 3, outData, i * 4);
			}
			switch (mod) {
			case 1:
				encode2pad(inData, num * 3, outData, num * 4);
				break;
			case 2:
				encode1pad(inData, num * 3, outData, num * 4);
				break;
			}
			return new String(outData);
		}

		/**
		 * Base64でエンコードされたデータをデコードします。
		 *
		 * @param inData
		 * @return デコードされたデータ
		 */
		public static byte[] decode(final String inData) {
			int num = (inData.length() / 4) - 1;
			int lastBytes = getLastBytes(inData);
			byte[] outData = new byte[num * 3 + lastBytes];
			for (int i = 0; i < num; i++) {
				decode(inData, i * 4, outData, i * 3);
			}
			switch (lastBytes) {
			case 1:
				decode1byte(inData, num * 4, outData, num * 3);
				break;
			case 2:
				decode2byte(inData, num * 4, outData, num * 3);
				break;
			default:
				decode(inData, num * 4, outData, num * 3);
			}
			return outData;
		}

		private static void encode(final byte[] inData, final int inIndex,
				final char[] outData, final int outIndex) {

			int i = ((inData[inIndex] & 0xff) << 16)
					+ ((inData[inIndex + 1] & 0xff) << 8)
					+ (inData[inIndex + 2] & 0xff);
			outData[outIndex] = ENCODE_TABLE[i >> 18];
			outData[outIndex + 1] = ENCODE_TABLE[(i >> 12) & 0x3f];
			outData[outIndex + 2] = ENCODE_TABLE[(i >> 6) & 0x3f];
			outData[outIndex + 3] = ENCODE_TABLE[i & 0x3f];
		}

		private static void encode2pad(final byte[] inData, final int inIndex,
				final char[] outData, final int outIndex) {

			int i = inData[inIndex] & 0xff;
			outData[outIndex] = ENCODE_TABLE[i >> 2];
			outData[outIndex + 1] = ENCODE_TABLE[(i << 4) & 0x3f];
			outData[outIndex + 2] = PAD;
			outData[outIndex + 3] = PAD;
		}

		private static void encode1pad(final byte[] inData, final int inIndex,
				final char[] outData, final int outIndex) {

			int i = ((inData[inIndex] & 0xff) << 8)
					+ (inData[inIndex + 1] & 0xff);
			outData[outIndex] = ENCODE_TABLE[i >> 10];
			outData[outIndex + 1] = ENCODE_TABLE[(i >> 4) & 0x3f];
			outData[outIndex + 2] = ENCODE_TABLE[(i << 2) & 0x3f];
			outData[outIndex + 3] = PAD;
		}

		private static void decode(final String inData, final int inIndex,
				final byte[] outData, final int outIndex) {

			byte b0 = DECODE_TABLE[inData.charAt(inIndex)];
			byte b1 = DECODE_TABLE[inData.charAt(inIndex + 1)];
			byte b2 = DECODE_TABLE[inData.charAt(inIndex + 2)];
			byte b3 = DECODE_TABLE[inData.charAt(inIndex + 3)];
			outData[outIndex] = (byte) (b0 << 2 & 0xfc | b1 >> 4 & 0x3);
			outData[outIndex + 1] = (byte) (b1 << 4 & 0xf0 | b2 >> 2 & 0xf);
			outData[outIndex + 2] = (byte) (b2 << 6 & 0xc0 | b3 & 0x3f);
		}

		private static void decode1byte(final String inData, final int inIndex,
				final byte[] outData, final int outIndex) {

			byte b0 = DECODE_TABLE[inData.charAt(inIndex)];
			byte b1 = DECODE_TABLE[inData.charAt(inIndex + 1)];
			outData[outIndex] = (byte) (b0 << 2 & 0xfc | b1 >> 4 & 0x3);
		}

		private static void decode2byte(final String inData, final int inIndex,
				final byte[] outData, final int outIndex) {

			byte b0 = DECODE_TABLE[inData.charAt(inIndex)];
			byte b1 = DECODE_TABLE[inData.charAt(inIndex + 1)];
			byte b2 = DECODE_TABLE[inData.charAt(inIndex + 2)];
			outData[outIndex] = (byte) (b0 << 2 & 0xfc | b1 >> 4 & 0x3);
			outData[outIndex + 1] = (byte) (b1 << 4 & 0xf0 | b2 >> 2 & 0xf);
		}

		private static int getLastBytes(final String inData) {
			int len = inData.length();
			if (inData.charAt(len - 2) == PAD) {
				return 1;
			}
			else if (inData.charAt(len - 1) == PAD) {
				return 2;
			}
			else {
				return 3;
			}
		}
	}
}
